<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstGLRenderbuffer: GStreamer Bad Plugins 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual">
<link rel="up" href="gl.html" title="OpenGL Helper Library">
<link rel="prev" href="gst-plugins-bad-libs-GstGLQuery.html" title="GstGLQuery">
<link rel="next" href="GstGLShader.html" title="GstGLShader">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-libs-GstGLRenderbuffer.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-libs-GstGLQuery.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GstGLShader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-GstGLRenderbuffer.top_of_page"></a>GstGLRenderbuffer</span></h2>
<p>GstGLRenderbuffer — memory subclass for GL renderbuffer objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GstGLRenderbufferAllocationParams</span> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-allocation-params-new" title="gst_gl_renderbuffer_allocation_params_new ()">gst_gl_renderbuffer_allocation_params_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GstGLRenderbufferAllocationParams</span> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-allocation-params-new-wrapped" title="gst_gl_renderbuffer_allocation_params_new_wrapped ()">gst_gl_renderbuffer_allocation_params_new_wrapped</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-get-height" title="gst_gl_renderbuffer_get_height ()">gst_gl_renderbuffer_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-get-id" title="gst_gl_renderbuffer_get_id ()">gst_gl_renderbuffer_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GstVideoGLTextureType</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-get-type" title="gst_gl_renderbuffer_get_type ()">gst_gl_renderbuffer_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-get-width" title="gst_gl_renderbuffer_get_width ()">gst_gl_renderbuffer_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#gst-gl-renderbuffer-init-once" title="gst_gl_renderbuffer_init_once ()">gst_gl_renderbuffer_init_once</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstGLRenderbuffer.html#GST-GL-RENDERBUFFER-ALLOCATOR-NAME:CAPS" title="GST_GL_RENDERBUFFER_ALLOCATOR_NAME">GST_GL_RENDERBUFFER_ALLOCATOR_NAME</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.description"></a><h2>Description</h2>
<p>GstGLRenderbuffer is a <a class="link" href="gst-plugins-bad-libs-gstglbasememory.html#GstGLBaseMemory" title="GstGLBaseMemory"><span class="type">GstGLBaseMemory</span></a> subclass providing support for
OpenGL renderbuffers.  </p>
<p><span class="type">GstGLRenderbuffer</span> is created or wrapped through <a class="link" href="gst-plugins-bad-libs-gstglbasememory.html#gst-gl-base-memory-alloc" title="gst_gl_base_memory_alloc ()"><code class="function">gst_gl_base_memory_alloc()</code></a>
with <span class="type">GstGLRenderbufferAllocationParams</span>.</p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-gl-renderbuffer-allocation-params-new"></a><h3>gst_gl_renderbuffer_allocation_params_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GstGLRenderbufferAllocationParams</span> *
gst_gl_renderbuffer_allocation_params_new
                               (<em class="parameter"><code><a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *context</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0GstAllocator.html#GstAllocationParams-struct"><span class="type">GstAllocationParams</span></a> *alloc_params</code></em>,
                                <em class="parameter"><code><span class="type">GstVideoGLTextureType</span> renderbuffer_type</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-allocation-params-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alloc_params</p></td>
<td class="parameter_description"><p> the <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstAllocator.html#GstAllocationParams-struct"><span class="type">GstAllocationParams</span></a> for sysmem mappings of the texture. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the width of the renderbuffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the height of the renderbuffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>renderbuffer_type</p></td>
<td class="parameter_description"><p>the <span class="type">GstVideoGLTextureType</span> for the created textures</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-allocation-params-new.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GstGLRenderbufferAllocationParams</span> for allocating <span class="type">GstGLRenderbuffer</span>'s</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-allocation-params-new-wrapped"></a><h3>gst_gl_renderbuffer_allocation_params_new_wrapped ()</h3>
<pre class="programlisting"><span class="returnvalue">GstGLRenderbufferAllocationParams</span> *
gst_gl_renderbuffer_allocation_params_new_wrapped
                               (<em class="parameter"><code><a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *context</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0GstAllocator.html#GstAllocationParams-struct"><span class="type">GstAllocationParams</span></a> *alloc_params</code></em>,
                                <em class="parameter"><code><span class="type">GstVideoGLTextureType</span> renderbuffer_type</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> gl_handle</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-allocation-params-new-wrapped.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alloc_params</p></td>
<td class="parameter_description"><p> the <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstAllocator.html#GstAllocationParams-struct"><span class="type">GstAllocationParams</span></a> for <em class="parameter"><code>tex_id</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the width of the renderbuffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the height of the renderbuffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>renderbuffer_type</p></td>
<td class="parameter_description"><p>the <span class="type">GstVideoGLTextureType</span> for <em class="parameter"><code>tex_id</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gl_handle</p></td>
<td class="parameter_description"><p>the GL handle to wrap</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> user data to call <em class="parameter"><code>notify</code></em>
with. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glibglib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-allocation-params-new-wrapped.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GstGLRenderbufferAllocationParams</span> for wrapping <em class="parameter"><code>gl_handle</code></em>
as a
renderbuffer</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-get-height"></a><h3>gst_gl_renderbuffer_get_height ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gst_gl_renderbuffer_get_height (<em class="parameter"><code><span class="type">GstGLRenderbuffer</span> *gl_mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-height.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gl_mem</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLRenderbuffer</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-height.returns"></a><h4>Returns</h4>
<p> the configured height of <em class="parameter"><code>gl_mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-get-id"></a><h3>gst_gl_renderbuffer_get_id ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gst_gl_renderbuffer_get_id (<em class="parameter"><code><span class="type">GstGLRenderbuffer</span> *gl_mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gl_mem</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLRenderbuffer</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-id.returns"></a><h4>Returns</h4>
<p> the OpenGL renderbuffer handle of <em class="parameter"><code>gl_mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-get-type"></a><h3>gst_gl_renderbuffer_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GstVideoGLTextureType</span>
gst_gl_renderbuffer_get_type (<em class="parameter"><code><span class="type">GstGLRenderbuffer</span> *gl_mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gl_mem</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLRenderbuffer</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-type.returns"></a><h4>Returns</h4>
<p> the <span class="type">GstVideoGLTextureType</span> of <em class="parameter"><code>gl_mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-get-width"></a><h3>gst_gl_renderbuffer_get_width ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gst_gl_renderbuffer_get_width (<em class="parameter"><code><span class="type">GstGLRenderbuffer</span> *gl_mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-width.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gl_mem</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLRenderbuffer</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-renderbuffer-get-width.returns"></a><h4>Returns</h4>
<p> the configured width of <em class="parameter"><code>gl_mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-renderbuffer-init-once"></a><h3>gst_gl_renderbuffer_init_once ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_renderbuffer_init_once (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initializes the GL Base Texture allocator. It is safe to call this function
multiple times.  This must be called before any other GstGLRenderbuffer operation.</p>
<p class="since">Since: 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GST-GL-RENDERBUFFER-ALLOCATOR-NAME:CAPS"></a><h3>GST_GL_RENDERBUFFER_ALLOCATOR_NAME</h3>
<pre class="programlisting">#define GST_GL_RENDERBUFFER_ALLOCATOR_NAME   "GLRenderbuffer"
</pre>
<p>The name of the GL renderbuffer allocator</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLRenderbuffer.see-also"></a><h2>See Also</h2>
<p><a href="/usr/share/gtk-doc/html/gstreamer-1.0GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a>, <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstAllocator.html#GstAllocator-struct"><span class="type">GstAllocator</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>